<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span>package com.palamida.util.collect;<a name="line.1"></a>
<span class="sourceLineNo">002</span><a name="line.2"></a>
<span class="sourceLineNo">003</span>import java.util.ListIterator;<a name="line.3"></a>
<span class="sourceLineNo">004</span><a name="line.4"></a>
<span class="sourceLineNo">005</span>/**<a name="line.5"></a>
<span class="sourceLineNo">006</span> * A {@link SortedCollection} which may contain duplicate elements and allows<a name="line.6"></a>
<span class="sourceLineNo">007</span> * users to access or remove elements by their integer index.<a name="line.7"></a>
<span class="sourceLineNo">008</span> * &lt;p&gt;<a name="line.8"></a>
<span class="sourceLineNo">009</span> * This is the &lt;i&gt;list&lt;/i&gt; analog to sorted set.<a name="line.9"></a>
<span class="sourceLineNo">010</span> * <a name="line.10"></a>
<span class="sourceLineNo">011</span> * @author Zhenya Leonov List<a name="line.11"></a>
<span class="sourceLineNo">012</span> * @param &lt;E&gt;<a name="line.12"></a>
<span class="sourceLineNo">013</span> *            the type of elements held in this list<a name="line.13"></a>
<span class="sourceLineNo">014</span> */<a name="line.14"></a>
<span class="sourceLineNo">015</span>public interface Sortedlist&lt;E&gt; extends SortedCollection&lt;E&gt; {<a name="line.15"></a>
<span class="sourceLineNo">016</span><a name="line.16"></a>
<span class="sourceLineNo">017</span>        /**<a name="line.17"></a>
<span class="sourceLineNo">018</span>         * Returns the element at the specified position.<a name="line.18"></a>
<span class="sourceLineNo">019</span>         * <a name="line.19"></a>
<span class="sourceLineNo">020</span>         * @param index<a name="line.20"></a>
<span class="sourceLineNo">021</span>         *            index of the element to return<a name="line.21"></a>
<span class="sourceLineNo">022</span>         * @return the element at the specified position<a name="line.22"></a>
<span class="sourceLineNo">023</span>         * @throws IndexOutOfBoundsException<a name="line.23"></a>
<span class="sourceLineNo">024</span>         *             if the specified index is out of range<a name="line.24"></a>
<span class="sourceLineNo">025</span>         */<a name="line.25"></a>
<span class="sourceLineNo">026</span>        public E get(int index);<a name="line.26"></a>
<span class="sourceLineNo">027</span><a name="line.27"></a>
<span class="sourceLineNo">028</span>        /**<a name="line.28"></a>
<span class="sourceLineNo">029</span>         * Removes and returns the element at the specified position (optional<a name="line.29"></a>
<span class="sourceLineNo">030</span>         * operation).<a name="line.30"></a>
<span class="sourceLineNo">031</span>         * <a name="line.31"></a>
<span class="sourceLineNo">032</span>         * @param index<a name="line.32"></a>
<span class="sourceLineNo">033</span>         *            the index of the element to be removed<a name="line.33"></a>
<span class="sourceLineNo">034</span>         * @return the element previously at the specified position<a name="line.34"></a>
<span class="sourceLineNo">035</span>         * @throws IndexOutOfBoundsException<a name="line.35"></a>
<span class="sourceLineNo">036</span>         *             if the specified index is out of range<a name="line.36"></a>
<span class="sourceLineNo">037</span>         */<a name="line.37"></a>
<span class="sourceLineNo">038</span>        public E remove(int index);<a name="line.38"></a>
<span class="sourceLineNo">039</span><a name="line.39"></a>
<span class="sourceLineNo">040</span>        /**<a name="line.40"></a>
<span class="sourceLineNo">041</span>         * Returns the index of the first occurrence of the specified element, or -1<a name="line.41"></a>
<span class="sourceLineNo">042</span>         * if the element is not present.<a name="line.42"></a>
<span class="sourceLineNo">043</span>         * <a name="line.43"></a>
<span class="sourceLineNo">044</span>         * @param o<a name="line.44"></a>
<span class="sourceLineNo">045</span>         *            element to search for<a name="line.45"></a>
<span class="sourceLineNo">046</span>         * @return the index of the first occurrence of the specified element, or -1<a name="line.46"></a>
<span class="sourceLineNo">047</span>         *         if the element is not present<a name="line.47"></a>
<span class="sourceLineNo">048</span>         */<a name="line.48"></a>
<span class="sourceLineNo">049</span>        public int indexOf(Object o);<a name="line.49"></a>
<span class="sourceLineNo">050</span><a name="line.50"></a>
<span class="sourceLineNo">051</span>        /**<a name="line.51"></a>
<span class="sourceLineNo">052</span>         * Returns the index of the last occurrence of the specified element, or -1<a name="line.52"></a>
<span class="sourceLineNo">053</span>         * if the element is not present.<a name="line.53"></a>
<span class="sourceLineNo">054</span>         * <a name="line.54"></a>
<span class="sourceLineNo">055</span>         * @param o<a name="line.55"></a>
<span class="sourceLineNo">056</span>         *            element to search for<a name="line.56"></a>
<span class="sourceLineNo">057</span>         * @return the index of the last occurrence of the specified element, or -1<a name="line.57"></a>
<span class="sourceLineNo">058</span>         *         if the element is not present<a name="line.58"></a>
<span class="sourceLineNo">059</span>         */<a name="line.59"></a>
<span class="sourceLineNo">060</span>        public int lastIndexOf(Object o);<a name="line.60"></a>
<span class="sourceLineNo">061</span><a name="line.61"></a>
<span class="sourceLineNo">062</span>        /**<a name="line.62"></a>
<span class="sourceLineNo">063</span>         * Returns a list iterator over the elements in this sorted-list.<a name="line.63"></a>
<span class="sourceLineNo">064</span>         * &lt;p&gt;<a name="line.64"></a>
<span class="sourceLineNo">065</span>         * The returned iterator does not support the<a name="line.65"></a>
<span class="sourceLineNo">066</span>         * {@link ListIterator#add(Object) add(E)} and<a name="line.66"></a>
<span class="sourceLineNo">067</span>         * {@link ListIterator#set(Object) set(E)} operations.<a name="line.67"></a>
<span class="sourceLineNo">068</span>         * <a name="line.68"></a>
<span class="sourceLineNo">069</span>         * @return a list iterator over the elements in this sorted-list<a name="line.69"></a>
<span class="sourceLineNo">070</span>         */<a name="line.70"></a>
<span class="sourceLineNo">071</span>        public ListIterator&lt;E&gt; listIterator();<a name="line.71"></a>
<span class="sourceLineNo">072</span><a name="line.72"></a>
<span class="sourceLineNo">073</span>        /**<a name="line.73"></a>
<span class="sourceLineNo">074</span>         * Returns a list iterator over the elements in this sorted-list, starting<a name="line.74"></a>
<span class="sourceLineNo">075</span>         * at the specified position.<a name="line.75"></a>
<span class="sourceLineNo">076</span>         * &lt;p&gt;<a name="line.76"></a>
<span class="sourceLineNo">077</span>         * The returned iterator does not support the<a name="line.77"></a>
<span class="sourceLineNo">078</span>         * {@link ListIterator#add(Object) add(E)} and<a name="line.78"></a>
<span class="sourceLineNo">079</span>         * {@link ListIterator#set(Object) set(E)} operations.<a name="line.79"></a>
<span class="sourceLineNo">080</span>         * <a name="line.80"></a>
<span class="sourceLineNo">081</span>         * @param index<a name="line.81"></a>
<span class="sourceLineNo">082</span>         *            index of the first element to be returned from the collection<a name="line.82"></a>
<span class="sourceLineNo">083</span>         *            iterator by a call to {@link ListIterator#next() next()}<a name="line.83"></a>
<span class="sourceLineNo">084</span>         * @return a list iterator over the elements in this sorted-list, starting<a name="line.84"></a>
<span class="sourceLineNo">085</span>         *         at the specified position<a name="line.85"></a>
<span class="sourceLineNo">086</span>         */<a name="line.86"></a>
<span class="sourceLineNo">087</span>        public ListIterator&lt;E&gt; listIterator(int index);<a name="line.87"></a>
<span class="sourceLineNo">088</span><a name="line.88"></a>
<span class="sourceLineNo">089</span>        /**<a name="line.89"></a>
<span class="sourceLineNo">090</span>         * Returns a view of the portion of this sorted-list whose elements range<a name="line.90"></a>
<span class="sourceLineNo">091</span>         * between {@code fromIndex}, inclusive, and {@code toIndex}, exclusive. If<a name="line.91"></a>
<span class="sourceLineNo">092</span>         * {@code fromIndex} and {@code toIndex} are equal, the returned sorted-list<a name="line.92"></a>
<span class="sourceLineNo">093</span>         * is empty. The returned sorted-list is backed by this sorted-list, so<a name="line.93"></a>
<span class="sourceLineNo">094</span>         * changes in the returned sorted-list are reflected in this sorted-list,<a name="line.94"></a>
<span class="sourceLineNo">095</span>         * and vice-versa.<a name="line.95"></a>
<span class="sourceLineNo">096</span>         * &lt;p&gt;<a name="line.96"></a>
<span class="sourceLineNo">097</span>         * The returned sorted-list will throw an {@code IllegalArgumentException}<a name="line.97"></a>
<span class="sourceLineNo">098</span>         * on an attempt to insert an element outside its range.<a name="line.98"></a>
<span class="sourceLineNo">099</span>         * <a name="line.99"></a>
<span class="sourceLineNo">100</span>         * @param fromIndex<a name="line.100"></a>
<span class="sourceLineNo">101</span>         *            low endpoint (inclusive) of the returned sorted-list<a name="line.101"></a>
<span class="sourceLineNo">102</span>         * @param toIndex<a name="line.102"></a>
<span class="sourceLineNo">103</span>         *            high endpoint (exclusive) of the returned sorted-list<a name="line.103"></a>
<span class="sourceLineNo">104</span>         * @return a view of the portion of this sorted-list within the specified<a name="line.104"></a>
<span class="sourceLineNo">105</span>         *         range<a name="line.105"></a>
<span class="sourceLineNo">106</span>         * @throws IndexOutOfBoundsException<a name="line.106"></a>
<span class="sourceLineNo">107</span>         *             if<a name="line.107"></a>
<span class="sourceLineNo">108</span>         *             {@code fromIndex &lt; 0 || toIndex &gt; size || fromIndex &gt; toIndex}<a name="line.108"></a>
<span class="sourceLineNo">109</span>         */<a name="line.109"></a>
<span class="sourceLineNo">110</span>        public Sortedlist&lt;E&gt; sublist(int fromIndex, int toIndex);<a name="line.110"></a>
<span class="sourceLineNo">111</span><a name="line.111"></a>
<span class="sourceLineNo">112</span>        /**<a name="line.112"></a>
<span class="sourceLineNo">113</span>         * Returns the hash code value for this sorted-list. The hash code of a<a name="line.113"></a>
<span class="sourceLineNo">114</span>         * sorted-list is defined to be the result of the following calculation:<a name="line.114"></a>
<span class="sourceLineNo">115</span>         * <a name="line.115"></a>
<span class="sourceLineNo">116</span>         * &lt;pre&gt;<a name="line.116"></a>
<span class="sourceLineNo">117</span>         * int hashCode = 1;<a name="line.117"></a>
<span class="sourceLineNo">118</span>         * for (E e : this)<a name="line.118"></a>
<span class="sourceLineNo">119</span>         *     hashCode = 31 * hashCode + (e == null ? 0 : e.hashCode());<a name="line.119"></a>
<span class="sourceLineNo">120</span>         * &lt;/pre&gt;<a name="line.120"></a>
<span class="sourceLineNo">121</span>         * <a name="line.121"></a>
<span class="sourceLineNo">122</span>         * @return the hash code value for this sorted-list<a name="line.122"></a>
<span class="sourceLineNo">123</span>         */<a name="line.123"></a>
<span class="sourceLineNo">124</span>        @Override<a name="line.124"></a>
<span class="sourceLineNo">125</span>        public int hashCode();<a name="line.125"></a>
<span class="sourceLineNo">126</span><a name="line.126"></a>
<span class="sourceLineNo">127</span>        /**<a name="line.127"></a>
<span class="sourceLineNo">128</span>         * Compares the specified object with this sorted-list for equality. Returns<a name="line.128"></a>
<span class="sourceLineNo">129</span>         * {@code true} if and only if the specified object is also a sorted-list,<a name="line.129"></a>
<span class="sourceLineNo">130</span>         * both sorted-lists have the same size, and all corresponding pairs of<a name="line.130"></a>
<span class="sourceLineNo">131</span>         * elements in the two sorted-lists are &lt;i&gt;equal&lt;/i&gt; according to the<a name="line.131"></a>
<span class="sourceLineNo">132</span>         * definition of this sorted-list.<a name="line.132"></a>
<span class="sourceLineNo">133</span>         * <a name="line.133"></a>
<span class="sourceLineNo">134</span>         * @return {@code true} if the specified object is {@code equal} to this<a name="line.134"></a>
<span class="sourceLineNo">135</span>         *         sorted-list<a name="line.135"></a>
<span class="sourceLineNo">136</span>         */<a name="line.136"></a>
<span class="sourceLineNo">137</span>        @Override<a name="line.137"></a>
<span class="sourceLineNo">138</span>        public boolean equals(Object o);<a name="line.138"></a>
<span class="sourceLineNo">139</span><a name="line.139"></a>
<span class="sourceLineNo">140</span>}<a name="line.140"></a>




























































</pre>
</div>
</body>
</html>
